FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.4.11  |  FHIR Version n/a  User: [n/a]

Resource OperationDefinition/FHIR Server from package hl7.fhir.uv.crmi#current (78 ms)

Package hl7.fhir.uv.crmi
Type OperationDefinition
Id Id
FHIR Version R4
Source http://hl7.org/fhir/uv/crmi/https://build.fhir.org/ig/HL7/crmi-ig/OperationDefinition-crmi-review.html
Url http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-review
Version 1.1.0-cibuild
Status active
Date 2024-08-29T03:38:40+00:00
Name CRMIReview
Title CRMI Review
Experimental False
Realm uv
Authority hl7
Description The review operation supports applying an review to an existing artifact, regardless of status. The operation sets the _date_ and _lastReviewDate_ elements of the reviewed artifact, and is otherwise only allowed to create ArtifactAssessment (Basic or cqf-artifactComment extension in R4) resources in the repository.
Type true
Kind operation

Resources that use this resource

No resources found


Resources that this resource uses

No resources found



Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition crmi-review

URL: [base]/ActivityDefinition/$review

URL: [base]/ActivityDefinition/[id]/$review

URL: [base]/CapabilityStatement/$review

URL: [base]/CapabilityStatement/[id]/$review

URL: [base]/CodeSystem/$review

URL: [base]/CodeSystem/[id]/$review

URL: [base]/CompartmentDefinition/$review

URL: [base]/CompartmentDefinition/[id]/$review

URL: [base]/ConceptMap/$review

URL: [base]/ConceptMap/[id]/$review

URL: [base]/ExampleScenario/$review

URL: [base]/ExampleScenario/[id]/$review

URL: [base]/GraphDefinition/$review

URL: [base]/GraphDefinition/[id]/$review

URL: [base]/ImplementationGuide/$review

URL: [base]/ImplementationGuide/[id]/$review

URL: [base]/Library/$review

URL: [base]/Library/[id]/$review

URL: [base]/Measure/$review

URL: [base]/Measure/[id]/$review

URL: [base]/Medication/$review

URL: [base]/Medication/[id]/$review

URL: [base]/MedicationKnowledge/$review

URL: [base]/MedicationKnowledge/[id]/$review

URL: [base]/MessageDefinition/$review

URL: [base]/MessageDefinition/[id]/$review

URL: [base]/NamingSystem/$review

URL: [base]/NamingSystem/[id]/$review

URL: [base]/OperationDefinition/$review

URL: [base]/OperationDefinition/[id]/$review

URL: [base]/PlanDefinition/$review

URL: [base]/PlanDefinition/[id]/$review

URL: [base]/Questionnaire/$review

URL: [base]/Questionnaire/[id]/$review

URL: [base]/SearchParameter/$review

URL: [base]/SearchParameter/[id]/$review

URL: [base]/StructureDefinition/$review

URL: [base]/StructureDefinition/[id]/$review

URL: [base]/StructureMap/$review

URL: [base]/StructureMap/[id]/$review

URL: [base]/Substance/$review

URL: [base]/Substance/[id]/$review

URL: [base]/TerminologyCapabilities/$review

URL: [base]/TerminologyCapabilities/[id]/$review

URL: [base]/TestScript/$review

URL: [base]/TestScript/[id]/$review

URL: [base]/ValueSet/$review

URL: [base]/ValueSet/[id]/$review

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INid1..1string

The logical id of the artifact being reviewed. The server must know the artifact (e.g. it is defined explicitly in the server's artifacts)

INreviewDate0..1date

The date on which the artifact was reviewed. If one is not provided the system date will be used.

INartifactAssessmentType0..1code

If a comment is submitted as part of the review, this parameter denotes the type of artifact comment.

INartifactAssessmentSummary0..1string

The body of the comment.

INartifactAssessmentTarget0..1canonical

The canonical url for the artifact being reviewed. The format is: [system]|[version] - e.g. http://loinc.org|2.56

INartifactAssessmentRelatedArtifact0..1uri

Optional supporting canonical URL / Reference for the comment.

INartifactAssessmentAuthor0..1Reference

A Reference to a resource containing information about the entity applying the review.

OUTreturn1..1Bundle

The Bundle result containing both the updated artifact and the ArtifactAssessment (Basic in R4) resource containing the review metadata

The review operation supports the ability of a repository to record commentary on a specific state of an artifact in an ArtifactAssessment (Basic or cqf-artifactComment extension in R4) resource by applying a review. The artifact assessments which are added by the operation must reference a version of the artifact.


Source

{
  "resourceType" : "OperationDefinition",
  "id" : "crmi-review",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition crmi-review</b></p><a name=\"crmi-review\"> </a><a name=\"hccrmi-review\"> </a><a name=\"crmi-review-en-US\"> </a><p>URL: [base]/ActivityDefinition/$review</p><p>URL: [base]/ActivityDefinition/[id]/$review</p><p>URL: [base]/CapabilityStatement/$review</p><p>URL: [base]/CapabilityStatement/[id]/$review</p><p>URL: [base]/CodeSystem/$review</p><p>URL: [base]/CodeSystem/[id]/$review</p><p>URL: [base]/CompartmentDefinition/$review</p><p>URL: [base]/CompartmentDefinition/[id]/$review</p><p>URL: [base]/ConceptMap/$review</p><p>URL: [base]/ConceptMap/[id]/$review</p><p>URL: [base]/ExampleScenario/$review</p><p>URL: [base]/ExampleScenario/[id]/$review</p><p>URL: [base]/GraphDefinition/$review</p><p>URL: [base]/GraphDefinition/[id]/$review</p><p>URL: [base]/ImplementationGuide/$review</p><p>URL: [base]/ImplementationGuide/[id]/$review</p><p>URL: [base]/Library/$review</p><p>URL: [base]/Library/[id]/$review</p><p>URL: [base]/Measure/$review</p><p>URL: [base]/Measure/[id]/$review</p><p>URL: [base]/Medication/$review</p><p>URL: [base]/Medication/[id]/$review</p><p>URL: [base]/MedicationKnowledge/$review</p><p>URL: [base]/MedicationKnowledge/[id]/$review</p><p>URL: [base]/MessageDefinition/$review</p><p>URL: [base]/MessageDefinition/[id]/$review</p><p>URL: [base]/NamingSystem/$review</p><p>URL: [base]/NamingSystem/[id]/$review</p><p>URL: [base]/OperationDefinition/$review</p><p>URL: [base]/OperationDefinition/[id]/$review</p><p>URL: [base]/PlanDefinition/$review</p><p>URL: [base]/PlanDefinition/[id]/$review</p><p>URL: [base]/Questionnaire/$review</p><p>URL: [base]/Questionnaire/[id]/$review</p><p>URL: [base]/SearchParameter/$review</p><p>URL: [base]/SearchParameter/[id]/$review</p><p>URL: [base]/StructureDefinition/$review</p><p>URL: [base]/StructureDefinition/[id]/$review</p><p>URL: [base]/StructureMap/$review</p><p>URL: [base]/StructureMap/[id]/$review</p><p>URL: [base]/Substance/$review</p><p>URL: [base]/Substance/[id]/$review</p><p>URL: [base]/TerminologyCapabilities/$review</p><p>URL: [base]/TerminologyCapabilities/[id]/$review</p><p>URL: [base]/TestScript/$review</p><p>URL: [base]/TestScript/[id]/$review</p><p>URL: [base]/ValueSet/$review</p><p>URL: [base]/ValueSet/[id]/$review</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>id</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The logical id of the artifact being reviewed. The server must know the artifact (e.g. it is defined explicitly in the server's artifacts)</p>\n</div></td></tr><tr><td>IN</td><td>reviewDate</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#date\">date</a></td><td/><td><div><p>The date on which the artifact was reviewed. If one is not provided the system date will be used.</p>\n</div></td></tr><tr><td>IN</td><td>artifactAssessmentType</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td/><td><div><p>If a comment is submitted as part of the review, this parameter denotes the type of artifact comment.</p>\n</div></td></tr><tr><td>IN</td><td>artifactAssessmentSummary</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The body of the comment.</p>\n</div></td></tr><tr><td>IN</td><td>artifactAssessmentTarget</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>The canonical url for the artifact being reviewed. The format is: [system]|[version] - e.g. http://loinc.org|2.56</p>\n</div></td></tr><tr><td>IN</td><td>artifactAssessmentRelatedArtifact</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#uri\">uri</a></td><td/><td><div><p>Optional supporting canonical URL / Reference for the comment.</p>\n</div></td></tr><tr><td>IN</td><td>artifactAssessmentAuthor</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a></td><td/><td><div><p>A Reference to a resource containing information about the entity applying the review.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>The Bundle result containing both the updated artifact and the ArtifactAssessment (Basic in R4) resource containing the review metadata</p>\n</div></td></tr></table><div><p>The review operation supports the ability of a repository to record commentary on a specific state of an artifact in an ArtifactAssessment (Basic or cqf-artifactComment extension in R4) resource by applying a review. The artifact assessments which are added by the operation must reference a version of the artifact.</p>\n</div></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "cds"
    }
  ],
  "url" : "http://hl7.org/fhir/uv/crmi/OperationDefinition/crmi-review",
  "version" : "1.1.0-cibuild",
  "name" : "CRMIReview",
  "title" : "CRMI Review",
  "status" : "active",
  "kind" : "operation",
  "date" : "2024-08-29T03:38:40+00:00",
  "publisher" : "HL7 International / Clinical Decision Support",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/dss"
        }
      ]
    }
  ],
  "description" : "The review operation supports applying an review to an existing artifact, regardless of status. The operation sets the _date_ and _lastReviewDate_ elements of the reviewed artifact, and is otherwise only allowed to create ArtifactAssessment (Basic or cqf-artifactComment extension in R4) resources in the repository.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "code" : "review",
  "comment" : "The review operation supports the ability of a repository to record commentary on a specific state of an artifact in an ArtifactAssessment (Basic or cqf-artifactComment extension in R4) resource by applying a review. The artifact assessments which are added by the operation must reference a version of the artifact.",
  "resource" : [
    "ActivityDefinition",
    "CapabilityStatement",
    "CodeSystem",
    "CompartmentDefinition",
    "ConceptMap",
    "ExampleScenario",
    "GraphDefinition",
    "ImplementationGuide",
    "Library",
    "Measure",
    "Medication",
    "MedicationKnowledge",
    "MessageDefinition",
    "NamingSystem",
    "OperationDefinition",
    "PlanDefinition",
    "Questionnaire",
    "SearchParameter",
    "StructureDefinition",
    "StructureMap",
    "Substance",
    "TerminologyCapabilities",
    "TestScript",
    "ValueSet"
  ],
  "system" : false,
  "type" : true,
  "instance" : true,
  "parameter" : [
    {
      "name" : "id",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "The logical id of the artifact being reviewed. The server must know the artifact (e.g. it is defined explicitly in the server's artifacts)",
      "type" : "string"
    },
    {
      "name" : "reviewDate",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The date on which the artifact was reviewed. If one is not provided the system date will be used.",
      "type" : "date"
    },
    {
      "name" : "artifactAssessmentType",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "If a comment is submitted as part of the review, this parameter denotes the type of artifact comment.",
      "type" : "code"
    },
    {
      "name" : "artifactAssessmentSummary",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The body of the comment.",
      "type" : "string"
    },
    {
      "name" : "artifactAssessmentTarget",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The canonical url for the artifact being reviewed. The format is: [system]|[version] - e.g. http://loinc.org|2.56",
      "type" : "canonical"
    },
    {
      "name" : "artifactAssessmentRelatedArtifact",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Optional supporting canonical URL / Reference for the comment.",
      "type" : "uri"
    },
    {
      "name" : "artifactAssessmentAuthor",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "A Reference to a resource containing information about the entity applying the review.",
      "type" : "Reference"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The Bundle result containing both the updated artifact and the ArtifactAssessment (Basic in R4) resource containing the review metadata",
      "type" : "Bundle"
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.